Operation Document.SetProperty (Update Property)

In component org.nuxeo.ecm.core.automation.coreContrib

Description

Set a single property value on the input document. The property is specified using its xpath. The document is automatically saved if 'save' parameter is true. If you unset the 'save' you need to save it later using Save Document operation. Return the modified document.

Operation id	Document.SetProperty
Category	Document
Label	Update Property
Requires
Since

Parameters

Name	Type	Required	Default value
xpath	string	yes
save	boolean	no	true
value	serializable	no

Signature

Inputs	document, documents
Outputs	document, documents

Implementation Information

Implementation Class	Class: org.nuxeo.ecm.automation.core.operations.document.SetDocumentProperty
Contributing Component	org.nuxeo.ecm.core.automation.coreContrib

JSON Definition

{
  "id" : "Document.SetProperty",
  "label" : "Update Property",
  "category" : "Document",
  "requires" : null,
  "description" : "Set a single property value on the input document. The property is specified using its xpath. The document is automatically saved if 'save' parameter is true. If you unset the 'save' you need to save it later using Save Document operation. Return the modified document.",
  "url" : "Document.SetProperty",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "xpath",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "save",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "true" ]
  }, {
    "name" : "value",
    "description" : null,
    "type" : "serializable",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}